Skip to content

Generate @scormflow/types from the backend OpenAPI spec#2

Merged
sushant-ipte merged 1 commit into
mainfrom
feat/openapi-types
Jun 4, 2026
Merged

Generate @scormflow/types from the backend OpenAPI spec#2
sushant-ipte merged 1 commit into
mainfrom
feat/openapi-types

Conversation

@sushant-ipte

Copy link
Copy Markdown
Contributor

Replaces the empty placeholder in packages/types/src with the openapi-typescript output from ../scorm-engine/openapi/openapi.yaml, and curates a public alias surface so consumers can write Course / Attempt / RuntimeState directly instead of indexing into components['schemas'].

pnpm run types:generate at the workspace root regenerates packages/types/src/openapi.d.ts on demand; once the backend ships @scormflow/types to npm on every tagged release, this file becomes the contract between the two repos.

Summary

Type of change

  • Feature (new functionality)
  • Fix (bug fix)
  • Refactor (no behavior change)
  • Docs / chore (no production code change)
  • Breaking change

Test plan

  • pnpm typecheck passes
  • pnpm test passes
  • pnpm build succeeds
  • Added / updated tests for new behavior

Related

Closes #

Replaces the empty placeholder in packages/types/src with the openapi-typescript
output from ../scorm-engine/openapi/openapi.yaml, and curates a public alias
surface so consumers can write Course / Attempt / RuntimeState directly instead
of indexing into components['schemas'].

`pnpm run types:generate` at the workspace root regenerates packages/types/src/openapi.d.ts
on demand; once the backend ships @scormflow/types to npm on every tagged release,
this file becomes the contract between the two repos.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@sushant-ipte sushant-ipte merged commit 3eba3fc into main Jun 4, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant